Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update client architecture documentation #976

Merged
merged 1 commit into from
Jun 12, 2023

Conversation

ghubertpalo
Copy link
Collaborator

Content

This PR includes an updated documentation for the new client architecture.

Pre-submit checklist

  • Branch
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update documentation website (if relevant)

Comments

None

Issue(s)

Closes #898

Copy link
Member

@jpraynaud jpraynaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Just one comment below


At this point, the **Cardano Node** will take over, start using the artifacts. and hopefully start addng new blocks to the ledger!
The client can be also used to verify and download the **Stake Distribution** used for signatures at the upcoming Cardano's Epoch. As of Snapshots, the certificate chain is validated, then the signers **Verification Keys** are checked. If valid, a multi-signature is computed and tested against the one used by the certificate. If the signature fails or is different, the verification stops, otherwise, the JSON representation of the stake distribution is saved on the disk for further use.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this instead 🙂

Suggested change
The client can be also used to verify and download the **Stake Distribution** used for signatures at the upcoming Cardano's Epoch. As of Snapshots, the certificate chain is validated, then the signers **Verification Keys** are checked. If valid, a multi-signature is computed and tested against the one used by the certificate. If the signature fails or is different, the verification stops, otherwise, the JSON representation of the stake distribution is saved on the disk for further use.
The client can be also used to verify and download the **Stake Distribution** used for signatures at the upcoming Cardano's Epoch. As of Snapshots, the certificate chain is validated, then the signers **Verification Keys** are checked. If valid, a fingerprint of the stake distribution is computed and tested against the one used by the certificate. If it is different, the verification stops, otherwise, the JSON representation of the stake distribution is saved on the disk for further use.

@ghubertpalo ghubertpalo force-pushed the greg/898/client_architecture_doc branch from e7e8576 to 8a01f41 Compare June 12, 2023 15:35
@ghubertpalo ghubertpalo merged commit 2bc2a38 into main Jun 12, 2023
@ghubertpalo ghubertpalo deleted the greg/898/client_architecture_doc branch June 12, 2023 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update architecture documentations for new types of data
2 participants